-
-
Notifications
You must be signed in to change notification settings - Fork 331
[RFC] Use mkdocs-material for Zarr-Python documentation #3118
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
I love the way this looks! Thanks so much for working on this. |
Apologies, I thought I had 👍'd previously. Now doing that retroactively in a general sense of the move and specifically for the style & the use of markdown. But I agree that we need a careful review of the pages (and personally, I liked the cards on the landing page) |
Thanks a lot for working on this, @maxrjones! I love the switch from
I'm with Josh on this one. Can we also add cards in mk-docs? |
This PR switches the docs from sphinx to mkdocs-material (closes #2894)
Preview: https://zarr--3118.org.readthedocs.build/en/3118/
Motivation for using mkdocs-material
Changes
Apart from the conversion to markdown and configuration updates, I made the following changes:
Review request context
I'm not looking for a final review here, but rather a general consensus on whether it's worth spending the time that'd be needed for the last 20% of polish.
TODO
changes/